Skip to content

Add a converter for datetime.datetime <--> Timestamp. #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Jul 31, 2025
Merged

Add a converter for datetime.datetime <--> Timestamp. #123

merged 6 commits into from
Jul 31, 2025

Conversation

@mjohanse-emr
Copy link
Contributor

@mjohanse-emr mjohanse-emr commented Jul 31, 2025 •
edited
Loading

What does this Pull Request accomplish?

Adds a DateTimeConverter class that converts python datetime.datetime objects to protobuf timestamp_pb2.Timestamp objects. I put this converter in builtin.py since we do not own either type. They are included as built-in types for python/protobuf.

timestamp_pb2.Timestamp has ToDatetime and FromDatetime functions which make this conversion easy.

Once we add converters for hightime.datetime and/or bintime.DateTime, we'll have to update the python type checking logic to differentiate between these three different "datetime" types. I'm not including any of that logic in this PR.

Why should this Pull Request be merged?

Implements part of AB#3166769

What testing has been done?

Unit tests, mypy, pyright, styleguide

I ran the all_types example and this is what shows up for datetime:
image

@github-actions
Copy link
Contributor

github-actions bot commented Jul 31, 2025 •
edited
Loading

Test Results

   10 files  ± 0     10 suites  ±0   21s ⏱️ ±0s
  224 tests + 3    224 ✅ + 3  0 💤 ±0  0 ❌ ±0 
2 190 runs  +30  2 190 ✅ +30  0 💤 ±0  0 ❌ ±0 

Results for commit 1f08864. ± Comparison against base commit 2e9b3ba.

This pull request removes 29 and adds 32 tests. Note that renamed tests count towards both. 
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object10-Collection.bool]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object11-Collection.bytes]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object12-Collection.float]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object13-Collection.int]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object14-Collection.str]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object15-Collection.bool]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object16-Collection.bytes]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object17-Collection.float]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object18-Collection.int]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object19-Collection.str]
…

tests.unit.test_convert ‑ test___python_datetime_datetime___to_any___valid_timestamppb2_value
tests.unit.test_convert ‑ test___timestamppb2_timestamp___from_any___valid_python_value
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object10-datetime]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object11-Collection.bool]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object12-Collection.bytes]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object13-Collection.float]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object14-Collection.int]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object15-Collection.str]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object16-Collection.bool]
tests.unit.test_convert ‑ test___various_python_objects___get_best_matching_type___returns_correct_type_string[python_object17-Collection.bytes]
…

♻️ This comment has been updated with latest results.

Update and run the all_types example.
891ff1b 
Signed-off-by: Michael Johansen <[email protected]>
@mjohanse-emr mjohanse-emr marked this pull request as ready for review July 31, 2025 15:46
mikeprosserni
mikeprosserni requested changes Jul 31, 2025
View reviewed changes
bkeryan
bkeryan reviewed Jul 31, 2025
View reviewed changes
jfriedri-ni
jfriedri-ni approved these changes Jul 31, 2025
View reviewed changes
Michael Johansen added 2 commits July 31, 2025 13:26
mikeprosserni
mikeprosserni reviewed Jul 31, 2025
View reviewed changes
mikeprosserni
mikeprosserni approved these changes Jul 31, 2025
View reviewed changes
@mjohanse-emr mjohanse-emr merged commit 70cce60 into main Jul 31, 2025
14 checks passed
@mjohanse-emr mjohanse-emr deleted the users/mjohanse/timestamp_converter branch July 31, 2025 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bkeryan bkeryan bkeryan left review comments

@jfriedri-ni jfriedri-ni jfriedri-ni approved these changes

@mikeprosserni mikeprosserni mikeprosserni approved these changes

@csjall csjall Awaiting requested review from csjall csjall is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mjohanse-emr @bkeryan @mikeprosserni @jfriedri-ni